/*
 *  Copyright (C) 2010 Glauco
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.balisunrise.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Nesta anotação estão definidas as propriedades para as coluna do grid que
 * estão encapsuladas em um entidade associada.
 *
 * @author Glauco
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface ColumnEmbedded {

    /**
     * Representa os nomes para construção do grid.
     * @return Retorna as alias.
     */
    public String[] alias() default "";

    /**
     * Indice da coluna no grid.
     * As colunas encapsuladas terão os seus indices adicionadas o valor deste
     * indice.
     * @return Retorna o indice da coluna no grid.
     */
    public int index();

    /**
     * Alias do grid encapsulado em uma entidade associada.
     * As definições das colunas do grid encapsulado serão adicionados ao
     * grid desta definição.
     * @return Retorna o Alias (nome) do grid encapsulado em um entidade
     * Associada.
     */
    public String grid() default "";

    /**
     * Propriedades adicionais para a definição.
     */
    public Property[] properties() default {};
}
